/*
 * Copyright (c) 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.data;

import com.google.api.client.http.HttpResponseException;
import com.google.api.client.xml.XmlNamespaceDictionary;

import java.io.IOException;

/**
 * Abstract service for the Google Data APIs which adds clientLogin specific
 * authentication and default GData version.
 * 
 * @author Nicolas Garnier (nivco@google.com)
 * @since 2.2
 */
public abstract class AbstractAtomService extends ExtendedGenericAtomService implements
    AuthenticatedService {

  /**
   * @see ServiceImpl#ServiceImpl(String, XmlNamespaceDictionary).
   */
  public AbstractAtomService(String applicationName, XmlNamespaceDictionary namespaceDict) {
    super(applicationName, namespaceDict);
    setApiVersion(getDefaultApiVersion());
  }

  // =============== Service Information ================

  /**
   * Returns the Default GData API version.
   */
  protected abstract String getDefaultApiVersion();

  /**
   * Returns the Client login code for the service.
   */
  protected abstract String getClientLoginServiceCode();

  /**
   * Returns the Authentication Scope to use for OAuth.
   */
  protected abstract String getServiceAuthenticationScope();

  // =============== Authentication ================

  public void setClientLoginCredentials(String username, String password)
      throws HttpResponseException, IOException {
    setClientLoginCredentials(username, password, AccountType.HOSTED_OR_GOOGLE,
        getClientLoginServiceCode());
  }

  public void setClientLoginCredentials(String username, String password, AccountType accountType)
      throws HttpResponseException, IOException {
    setClientLoginCredentials(username, password, accountType, getClientLoginServiceCode());
  }

}
